home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / VISUALBA / DFVB19.ZIP / DFRAMEVB.DOC next >
Text File  |  1994-03-09  |  62KB  |  1,187 lines
  1.  
  2.  
  3.                                D O O R F R A M E
  4.                                   Version 1.9
  5.  
  6.                         A BBS Doors Development Library
  7.                        for the Visual Basic DOS compiler
  8.  
  9.                               Copyright (c)1993
  10.                       By Richard Paquette and Chuck Valecek
  11.                              All rights reserved.
  12.  
  13.                             Support boards are:
  14.  
  15.                               The Livewire BBS 
  16.                             - Richard Paquette - 
  17.                    - Public Nodes (2) 609-235-5297 (HST) -
  18.                          
  19.                               Suburban Software
  20.                               - Chuck Valecek - 
  21.                 - Public Nodes (2) 708-636-6694 / 708-636-6697 -
  22.  
  23.  
  24.  
  25.  
  26. DOORFRAME v1.8 - Users Guide - Page i
  27.  
  28.  
  29.                                 C O N T E N T S
  30.                                =================
  31.  
  32.         Warranty ............................................ ii
  33.         Copyright notice .................................... ii
  34.         Distribution ........................................ ii
  35.         Description ......................................... ii
  36.         BOX.IT .............................................. 1
  37.         BACK.SPACE .......................................... 2
  38.         CLEARBUFFER ......................................... 2
  39.         CLREOL .............................................. 2
  40.         CLRMOL .............................................. 2
  41.         CLRSOL .............................................. 2
  42.         CLRSCRN ............................................. 2
  43.         DE.LAY .............................................. 2
  44.         DETECT.ANSI ......................................... 2
  45.         DIS.PLAY ............................................ 3
  46.         ENTER ............................................... 4
  47.         EXIT.DOOR ........................................... 4
  48.         IN.PUT .............................................. 4
  49.         IN.KEY .............................................. 4
  50.         INITIALIZE .......................................... 5
  51.         LINES ............................................... 5
  52.         MAKE.BLT ............................................ 6
  53.         MAKE.BLT.CURRENT .................................... 6
  54.         MORE ................................................ 6
  55.         MUSIC ............................................... 6
  56.         OUT.PUT ............................................. 6
  57.         SEND ................................................ 7
  58.         SENDANSI ............................................ 7
  59.         SHOW.BLT ............................................ 7
  60.         COLOR TABLE ......................................... 8
  61.         CONFIGURATION FILE FORMAT ........................... 9
  62.         PCBOARD.SYS VARIABLES ............................... 10
  63.         USERS.SYS VARIABLES ................................. 12
  64.         DOOR.SYS VARIABLES .................................. 13
  65.         USERINFO.DAT VARIABLES .............................. 15
  66.         DORINFOx.DEF VARIABLES .............................. 15
  67.         CALLINFO.BBS VARIABLES .............................. 16
  68.         SFDOORS.DAT VARIABLES ............................... 18
  69.         MISCELLANEOUS NOTES ................................. 20
  70.  
  71.  
  72. DOORFRAME v1.8 - Users Guide - Page ii
  73.  
  74.  
  75.                                    Warranty
  76.  
  77.     This product is provided "as is" without warranty of any kind. The entire
  78.     risk as to the results and  performance of the program is assumed by you.
  79.     Futhermore, the  author does  not warrant, guarantee, or  make any  other
  80.     representations regarding  the use of,  or the  results of the use of the
  81.     program,  and you  rely on the  program and  results  solely at  your own
  82.     risk.  The author  cannot and  will not accept  responsibility for system
  83.     damage, loss of profit, or any other special, consequential or incidental 
  84.     damages  resulting  from  the  use  or  inability  to  use this  product.
  85.  
  86.                                    Copyright
  87.  
  88.     DOORFRAME (Copyright (c) 1993 by Richard Paquette & Chuck Valecek) is being
  89.     distributed as Shareware. Under this concept you may use the SHAREWARE or
  90.     (unregistered) version for a reasonable period of time for evaluation after
  91.     which you should either register your copy or discontinue  usage.
  92.  
  93.                                  Distribution
  94.  
  95.     You  are encouraged to distribute DOORFRAME provided that all files
  96.     contained in the archive are distributed in their original and
  97.     unmodified state.
  98.  
  99.                                   Description
  100.     
  101.     DOORFRAME is a subroutine library for developing online BBS Doors for
  102.     systems that are compatible with PCBOARD.SYS, USERS.SYS, DOOR.SYS,
  103.     CALLINFO.BBS, USERINFO.DAT, SFDOORS.DAT, or DORINFOx.DEF for
  104.     interfacing to the BBS.
  105.     This version of DoorFrame was written for MicroSoft's Visual Basic for
  106.     DOS (tm). DoorFrame also utilizes some of the routines contained in Tom 
  107.     Hanlin's PBClone library. The COM routines are handled by the QBSerial 
  108.     I/O library.
  109.  
  110.  
  111. DOORFRAME v1.8 - Users Guide - Page 1
  112.  
  113.  
  114.                               DOORFRAME ROUTINES
  115.                              ====================
  116.  
  117. NOTE: 
  118. Since the subroutines are DECLAREd in DFRAMEVB.INC (you DID $INCLUDE: it 
  119. didn't you?) you should not use the CALL statement. Type the name of the 
  120. subroutine and list it's parameters (if any) without the enclosing 
  121. parentheses. For example:
  122.  
  123. DIS.PLAY MSG$,FG%,BG%,BLINK%,BELL%,XPOS%,YPOS%,NL%,CENTER%,CAPS%,CODES%
  124. -----------------------------------------------------------------------------
  125.  
  126. SUBROUTINE: 
  127. BOX.IT SROW%,SCOL%,EROW%,ECOL%,BTYPE%,BFG%,BBG%,FFG%,FBG%,FCHAR%,SHADOW%,TITLE$,HFG%,HBG%
  128. PARAMETERS: SROW%    - ROW the box is to start at. Valid numbers are 1 - 22.
  129.                        Accepts an INTEGER number or variable.
  130.             SCOL%    - COLUMN the box is to start at. Valid numbers are 1 - 79.
  131.                        Accepts an INTEGER number or variable.
  132.             EROW%    - ROW the box is to end at. Valid numbers are 2 - 23.
  133.                        Accepts an INTEGER number or variable.
  134.             ECOL%    - COLUMN the box is to end at. Valid numbers are 2 - 80.
  135.                        Accepts an INTEGER number or variable.
  136.             BTYPE%   - Type of border. Accepts an INTEGER number or variable.
  137.                          0 = No border (spaces all the way around).
  138.                          1 = Single line all the way around.
  139.                          2 = Double line all the way around.
  140.                          3 = Double line on sides, single on top and bottom.
  141.                          4 = Single line on sides, double on top and bottom.
  142.             BFG%     - Foreground color of the border. (See color table)
  143.                        Accepts an INTEGER number or variable.
  144.             BBG%     - Background color of the border. (See color table)
  145.                        Accepts an INTEGER number or variable.
  146.             FFG%     - Foreground color of the box fill characters.
  147.                        Accepts an INTEGER number or variable.
  148.             FBG%     - Background color of the box fill characters.
  149.                        Accepts an INTEGER number or variable.
  150.             FCHAR%   - ASCII number of the character to fill box with.
  151.                        EX: 32 = SPACE, 65 = A, 206 = ╬
  152.             SHADOW%  - -1 = no Shadow, 0 - 7 = Background color of the Shadow. 
  153.                        This will put a Shadow on the right and bottom edges 
  154.                        of the box.
  155.             TITLE$   - Displays a title centered on the top border.
  156.                        Accepts a STRING variable or QUOTED TEXT.
  157.             HFG%     - Foreground color of TITLE$
  158.             HFG%     - Background color of TITLE$
  159.  
  160. DESCRIPTION: Draws a BOX with various style borders. The inside of the
  161.              BOX may be filled with any ASCII character you choose. The
  162.              u